home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / find / dist / lib / regex.h < prev    next >
Encoding:
C/C++ Source or Header  |  1992-07-10  |  18.1 KB  |  488 lines
  1. /* Definitions for data structures and routines for the regular
  2.    expression library, version 0.8.
  3.  
  4.    Copyright (C) 1985, 89, 90, 91, 92 Free Software Foundation, Inc.
  5.  
  6.    This program is free software; you can redistribute it and/or modify
  7.    it under the terms of the GNU General Public License as published by
  8.    the Free Software Foundation; either version 2, or (at your option)
  9.    any later version.
  10.  
  11.    This program is distributed in the hope that it will be useful,
  12.    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.    GNU General Public License for more details.
  15.  
  16.    You should have received a copy of the GNU General Public License
  17.    along with this program; if not, write to the Free Software
  18.    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19.  
  20. #ifndef __REGEXP_LIBRARY_H__
  21. #define __REGEXP_LIBRARY_H__
  22.  
  23. /* POSIX says that <sys/types.h> must be included before <regex.h>.  */
  24.  
  25. /* The following bits are used to determine the regexp syntax we
  26.    recognize.  The set/not-set meanings are chosen so that Emacs syntax
  27.    remains the value 0.  The bits are given in alphabetical order, and
  28.    the definitions shifted by one from the previous bit; thus, when we
  29.    add or remove a bit, only one other definition need change.  */
  30. typedef unsigned reg_syntax_t;
  31.  
  32. /* If this bit is not set, then \ inside a bracket expression is literal.
  33.    If set, then such a \ quotes the following character.  */
  34. #define RE_BACKSLASH_ESCAPE_IN_LISTS (1)
  35.  
  36. /* If this bit is not set, then + and ? are operators, and \+ and \? are
  37.      literals. 
  38.    If set, then \+ and \? are operators and + and ? are literals.  */
  39. #define RE_BK_PLUS_QM (RE_BACKSLASH_ESCAPE_IN_LISTS << 1)
  40.  
  41. /* If this bit is set, then character classes are supported.  They are:
  42.      [:alpha:], [:upper:], [:lower:],  [:digit:], [:alnum:], [:xdigit:],
  43.      [:space:], [:print:], [:punct:], [:graph:], and [:cntrl:].
  44.    If not set, then character classes are not supported.  */
  45. #define RE_CHAR_CLASSES (RE_BK_PLUS_QM << 1)
  46.  
  47. /* If this bit is set, then ^ and $ are always anchors (outside bracket
  48.      expressions).
  49.    If this bit is not set, then it depends:
  50.         ^  is an anchor if it is at the beginning of a regular
  51.            expression or after an open-group or an alternation operator;
  52.         $  is an anchor if it is at the end of a regular expression, or
  53.            before a close-group or an alternation operator.  
  54.    This bit could be (re)combined with RE_CONTEXT_INDEP_OPS, because
  55.    POSIX now says that the behavior of * etc. in leading positions is
  56.    undefined.  We have already implemented a previous draft which
  57.    made those constructs invalid, so we may as well not change the code
  58.    back.  */
  59. #define RE_CONTEXT_INDEP_ANCHORS (RE_CHAR_CLASSES << 1)
  60.  
  61. /* If this bit is set, then special characters are always special
  62.      regardless of where they are in the pattern.
  63.    If this bit is not set, then special characters are special only in
  64.      some contexts; otherwise they are ordinary.  Specifically, 
  65.      * + ? and intervals are only special when not after the beginning,
  66.      open-group, or alternation operator.  */
  67. #define RE_CONTEXT_INDEP_OPS (RE_CONTEXT_INDEP_ANCHORS << 1)
  68.  
  69. /* If this bit is set, then *, +, ?, and { cannot be first in an re or
  70.    immediately after an alternation or begin-group operator.
  71.    Furthermore, alternation cannot be first or last in an re, or
  72.    immediately follow another alternation or begin-group.  */
  73. #define RE_CONTEXT_INVALID_OPS (RE_CONTEXT_INDEP_OPS << 1)
  74.  
  75. /* If this bit is set, then . matches a newline.
  76.    If not set, then it doesn't.  */
  77. #define RE_DOT_NEWLINE (RE_CONTEXT_INVALID_OPS << 1)
  78.  
  79. /* If this bit is set, then period doesn't match a null.
  80.    If not set, then it does.  */
  81. #define RE_DOT_NOT_NULL (RE_DOT_NEWLINE << 1)
  82.  
  83. /* If this bit is set, nonmatching lists [^...] do not match newline.
  84.    If not set, they do.  */
  85. #define RE_HAT_LISTS_NOT_NEWLINE (RE_DOT_NOT_NULL << 1)
  86.  
  87. /* If this bit is set, either \{...\} or {...} defines an
  88.      interval, depending on RE_NO_BK_BRACES. 
  89.    If not set, \{, \}, {, and } are literals.  */
  90. #define RE_INTERVALS (RE_HAT_LISTS_NOT_NEWLINE << 1)
  91.  
  92. /* If this bit is set,  +, ? and | aren't recognized as operators.
  93.    If not set, they are.  */
  94. #define RE_LIMITED_OPS (RE_INTERVALS << 1)
  95.  
  96. /* If this bit is set, newline is an alternation operator.
  97.    If not set, newline is literal.  */
  98. #define RE_NEWLINE_ALT (RE_LIMITED_OPS << 1)
  99.  
  100. /* If this bit is set, newline in the pattern is an ordinary character.
  101.    If not set, newline before ^ or after $ allows the ^ or $ to be an
  102.      anchor.  */
  103. #define RE_NEWLINE_ORDINARY (RE_NEWLINE_ALT << 1)
  104.  
  105. /* If this bit is not set, then \{ and \} defines an interval,
  106.      and { and } are literals.
  107.    If set, then { and } defines an interval, and \{ and \} are literals.  */
  108. #define RE_NO_BK_BRACES (RE_NEWLINE_ORDINARY << 1)
  109.  
  110. /* If this bit is set, (...) defines a group, and \( and \) are literals.
  111.    If not set, \(...\) defines a group, and ( and ) are literals.  */
  112. #define RE_NO_BK_PARENS (RE_NO_BK_BRACES << 1)
  113.  
  114. /* If this bit is set, then back references (i.e., \<digit>) are not
  115.      recognized.
  116.    If not set, then they are.  */
  117. #define RE_NO_BK_REFS (RE_NO_BK_PARENS << 1)
  118.  
  119. /* If this bit is set, then | is an alternation operator, and \| is literal. 
  120.    If not set, then \| is an alternation operator, and | is literal.  */
  121. #define RE_NO_BK_VBAR (RE_NO_BK_REFS << 1)
  122.  
  123. /* If this bit is set, then you can't have empty alternatives.
  124.    If not set, then you can.  */
  125. #define RE_NO_EMPTY_ALTS (RE_NO_BK_VBAR << 1)
  126.  
  127. /* If this bit is set, then you can't have empty groups.
  128.    If not set, then you can.  */
  129. #define RE_NO_EMPTY_GROUPS (RE_NO_EMPTY_ALTS << 1)
  130.  
  131. /* If this bit is set, then an ending range point has to collate higher
  132.      than or equal to the starting range point.
  133.    If not set, then when the ending range point collates higher than the
  134.      starting range point, we consider such a range to be empty.  */ 
  135. #define RE_NO_EMPTY_RANGES (RE_NO_EMPTY_GROUPS << 1)
  136.  
  137. /* If this bit is set, then all back references must refer to a preceding
  138.      subexpression.
  139.    If not set, then a back reference to a nonexistent subexpression is
  140.      treated as literal characters.  */ 
  141. #define RE_NO_MISSING_BK_REF (RE_NO_EMPTY_RANGES << 1)
  142.  
  143. /* If this bit is set, then Regex considers an unmatched close-group
  144.      operator to be the ordinary character parenthesis.
  145.    If not set, then an unmatched close-group operator is invalid.  */
  146. #define RE_UNMATCHED_RIGHT_PAREN_ORD (RE_NO_MISSING_BK_REF << 1)
  147.  
  148. /* This global variable defines the particular regexp syntax to use (for
  149.    some interfaces).  When a regexp is compiled, the syntax used is
  150.    stored in the pattern buffer, so changing this does not affect
  151.    already-compiled regexps.  */
  152. extern reg_syntax_t obscure_syntax;
  153.  
  154.  
  155.  
  156. /* Define combinations of the above bits for the standard possibilities.
  157.    (The [[[ comments delimit what gets put into the Texinfo file.) */ 
  158. /* [[[begin syntaxes]]] */
  159. #define RE_SYNTAX_EMACS 0
  160.  
  161. #define RE_SYNTAX_AWK                            \
  162.   (RE_BACKSLASH_ESCAPE_IN_LISTS | RE_DOT_NOT_NULL            \
  163.    | RE_NEWLINE_ORDINARY | RE_NO_BK_PARENS                \
  164.    | RE_NO_BK_REFS | RE_NO_BK_VAR                    \
  165.    | RE_NO_EMPTY_ALTS | RE_NO_EMPTY_RANGES                \
  166.    | RE_UNMATCHED_RIGHT_PAREN_ORD)
  167.  
  168. #define RE_SYNTAX_POSIX_AWK                         \
  169.   (RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS)
  170.  
  171. #define RE_SYNTAX_GREP                            \
  172.   (RE_BK_PLUS_QM | RE_NEWLINE_ALT)
  173.  
  174. #define RE_SYNTAX_EGREP                            \
  175.   (RE_CONTEXT_INDEP_ANCHORS | RE_CONTEXT_INDEP_OPS            \
  176.    | RE_NEWLINE_ALT | RE_NO_BK_PARENS | RE_NO_BK_VBAR)
  177.  
  178. #define RE_SYNTAX_POSIX_BASIC                        \
  179.   (RE_CHAR_CLASSES | RE_DOT_NEWLINE                    \
  180.    | RE_DOT_NOT_NULL | RE_INTERVALS | RE_LIMITED_OPS            \
  181.    | RE_NEWLINE_ORDINARY | RE_NO_EMPTY_RANGES | RE_NO_MISSING_BK_REF)
  182.  
  183. #define RE_SYNTAX_POSIX_EXTENDED                    \
  184.   (RE_CHAR_CLASSES | RE_CONTEXT_INDEP_ANCHORS                \
  185.    | RE_CONTEXT_INVALID_OPS | RE_DOT_NEWLINE | RE_DOT_NOT_NULL        \
  186.    | RE_INTERVALS | RE_NEWLINE_ORDINARY | RE_NO_BK_BRACES        \
  187.    | RE_NO_BK_PARENS | RE_NO_BK_REFS | RE_NO_BK_VBAR            \
  188.    | RE_NO_EMPTY_ALTS | RE_NO_EMPTY_GROUPS | RE_NO_EMPTY_RANGES        \
  189.    | RE_UNMATCHED_RIGHT_PAREN_ORD)
  190. /* [[[end syntaxes]]] */
  191.  
  192. /* Maximum number of duplicates an interval can allow.  */
  193. #define RE_DUP_MAX  ((1 << 15) - 1) 
  194.  
  195.  
  196. /* POSIX `cflags' bits (i.e., information for regcomp).  */
  197.  
  198. /* If this bit is set, then use extended regular expression syntax.
  199.    If not set, then use basic regular expression syntax.  */
  200. #define REG_EXTENDED 1
  201.  
  202. /* If this bit is set, then ignore case when matching.
  203.    If not set, then case is significant.  */
  204. #define REG_ICASE (REG_EXTENDED << 1)
  205.  
  206. /* If this bit is set, then anchors do not match at newline
  207.      characters in the string.
  208.    If not set, then anchors do match at newlines.  */
  209. #define REG_NEWLINE (REG_ICASE << 1)
  210.  
  211. /* If this bit is set, then report only success or fail in regexec.
  212.    If not set, then returns differ between not matching and errors.  */
  213. #define REG_NOSUB (REG_NEWLINE << 1)
  214.  
  215.  
  216. /* POSIX `eflags' bits (i.e., information for regexec).  */
  217.  
  218. /* If this bit is set, then the beginning-of-line operator doesn't match
  219.      the beginning of the string (presumably because it's not the
  220.      beginning of a line).
  221.    If not set, then the beginning-of-line operator does match the
  222.      beginning of the string.  */
  223. #define REG_NOTBOL 1
  224.  
  225. /* Like REG_NOTBOL, except for the end-of-line.  */
  226. #define REG_NOTEOL (1 << 1)
  227.  
  228.  
  229. /* If any error codes are removed, changed, or added, update the
  230.    `re_error_msg' table in regex.c.  */
  231. typedef enum
  232. {
  233.   REG_NOERROR = 0,    /* Success.  */
  234.   REG_NOMATCH,        /* Didn't find a match (for regexec).  */
  235.  
  236.   /* POSIX regcomp return error codes.  (In the order listed in the
  237.      standard.)  */
  238.   REG_BADPAT,        /* Invalid pattern.  */
  239.   REG_ECOLLATE,        /* Not implemented.  */
  240.   REG_ECTYPE,        /* Invalid character class name.  */
  241.   REG_EESCAPE,        /* Trailing backslash.  */
  242.   REG_ESUBREG,        /* Invalid back reference.  */
  243.   REG_EBRACK,        /* Unmatched left bracket.  */
  244.   REG_EPAREN,        /* Parenthesis imbalance.  */ 
  245.   REG_EBRACE,        /* Unmatched \{.  */
  246.   REG_BADBR,        /* Invalid contents of \{\}.  */
  247.   REG_ERANGE,        /* Invalid range end.  */
  248.   REG_ESPACE,        /* Ran out of memory.  */
  249.   REG_BADRPT,        /* No preceding re for repetition op.  */
  250.  
  251.   /* Error codes we've added.  */
  252.   REG_EEND,        /* Premature end.  */
  253.   REG_ESIZE,        /* Compiled pattern bigger than 2^16 bytes.  */
  254.   REG_ERPAREN        /* Unmatched ) or \); not returned from regcomp.  */
  255. } reg_errcode_t;
  256.  
  257. /* This data structure represents a compiled pattern.  Before calling
  258.    the pattern compiler, the fields `buffer', `allocated', `fastmap',
  259.    `translate', and `no_sub' can be set.  After the pattern has been
  260.    compiled, the `re_nsub' field is available.  All other fields are
  261.    private to the regex routines.  */
  262.  
  263. struct re_pattern_buffer
  264. {
  265. /* [[[begin pattern_buffer]]] */
  266.     /* Space that holds the compiled pattern.  It is declared as
  267.           `unsigned char *' because its elements are
  268.            sometimes used as array indexes.  */
  269.   unsigned char *buffer;
  270.  
  271.     /* Number of bytes to which `buffer' points.  */
  272.   unsigned long allocated;
  273.  
  274.     /* Number of bytes actually used in `buffer'.  */
  275.   unsigned long used;    
  276.  
  277.         /* Syntax setting with which the pattern was compiled.  */
  278.   reg_syntax_t syntax;
  279.  
  280.         /* Pointer to a fastmap, if any, otherwise zero.  re_search uses
  281.            the fastmap, if there is one, to skip over impossible
  282.            starting points for matches.  */
  283.   char *fastmap;
  284.  
  285.         /* Either a translate table to apply to all characters before
  286.            comparing them, or zero for no translation.  The translation
  287.            is applied to a pattern when it is compiled and to a string
  288.            when it is matched.  */
  289.   char *translate;
  290.  
  291.     /* Number of subexpressions found by the compiler.  */
  292.   size_t re_nsub;
  293.  
  294.         /* Zero if this pattern cannot match the empty string, one else.
  295.            Well, in truth it's used only in `re_search_2', to see
  296.            whether or not we should use the fastmap, so we don't set
  297.            this absolutely perfectly; see `re_compile_fastmap' (the
  298.            `duplicate' case).  */
  299.   unsigned can_be_null : 1;
  300.  
  301.         /* If REGS_UNALLOCATED, allocate space in the `regs' structure
  302.              for `max (RE_NREGS, re_nsub + 1)' groups.
  303.            If REGS_REALLOCATE, reallocate space if necessary.
  304.            If REGS_FIXED, use what's there.  */
  305. #define REGS_UNALLOCATED 0
  306. #define REGS_REALLOCATE 1
  307. #define REGS_FIXED 2
  308.   unsigned regs_allocated : 2;
  309.  
  310.         /* Set to zero when regex_compile compiles a pattern; set to one
  311.            by re_compile_fastmap when it updates the fastmap, if any.  */
  312.   unsigned fastmap_accurate : 1;
  313.  
  314.         /* If set, regexec reports only success or failure and does not
  315.            return anything in pmatch.  */
  316.   unsigned no_sub : 1;
  317.  
  318.         /* If set, a beginning-of-line anchor doesn't match at the
  319.            beginning of the string.  */ 
  320.   unsigned not_bol : 1;
  321.  
  322.         /* Similarly for an end-of-line anchor.  */
  323.   unsigned not_eol : 1;
  324.  
  325.         /* If true, an anchor at a newline matches.  */
  326.   unsigned newline_anchor : 1;
  327.  
  328. /* [[[end pattern_buffer]]] */
  329. };
  330.  
  331. typedef struct re_pattern_buffer regex_t;
  332.  
  333.  
  334. /* search.c (search_buffer) in Emacs needs this one opcode value.  It is
  335.    defined both in `regex.c' and here.  */
  336. #define RE_EXACTN_VALUE 1
  337.  
  338. /* Type for byte offsets within the string.  POSIX mandates this.  */
  339. typedef int regoff_t;
  340.  
  341.  
  342. /* This is the structure we store register match data in.  See
  343.    regex.texinfo for a full description of what registers match.  */
  344. struct re_registers
  345. {
  346.   unsigned num_regs;
  347.   regoff_t *start;
  348.   regoff_t *end;
  349. };
  350.  
  351.  
  352. /* If `regs_allocated' is REGS_UNALLOCATED in the pattern buffer,
  353.    `re_match_2' returns information about at least this many registers
  354.    the first time a `regs' structure is passed.  */
  355. #ifndef RE_NREGS
  356. #define RE_NREGS 30
  357. #endif
  358.  
  359.  
  360. /* POSIX specification for registers.  Aside from the different names than
  361.    `re_registers', POSIX uses an array of structures, instead of a
  362.    structure of arrays.  */
  363. typedef struct
  364. {
  365.   regoff_t rm_so;  /* Byte offset from string's start to substring's start.  */
  366.   regoff_t rm_eo;  /* Byte offset from string's start to substring's end.  */
  367. } regmatch_t;
  368.  
  369. /* Declarations for routines.  */
  370.  
  371. #if __STDC__
  372.  
  373. /* Sets the current syntax to SYNTAX.  You can also simply assign to the
  374.    `obscure_syntax' variable.  */
  375. extern reg_syntax_t re_set_syntax (reg_syntax_t syntax);
  376.  
  377. /* Compile the regular expression PATTERN, with length LENGTH
  378.    and syntax given by the global `obscure_syntax', into the buffer
  379.    BUFFER.  Return NULL if successful, and an error string if not.  */
  380. extern const char *re_compile_pattern (const char *pattern, int length,
  381.                                        struct re_pattern_buffer *buffer);
  382.  
  383.  
  384. /* Compile a fastmap for the compiled pattern in BUFFER; used to
  385.    accelerate searches.  Return 0 if successful and -2 if was an
  386.    internal error.  */
  387. extern int re_compile_fastmap (struct re_pattern_buffer *buffer);
  388.  
  389.  
  390. /* Search in the string STRING (with length LENGTH) for the pattern
  391.    compiled into BUFFER.  Start searching at position START, for RANGE
  392.    characters.  Return the starting position of the match, -1 for no
  393.    match, or -2 for an internal error.  Also return register
  394.    information in REGS (if REGS and BUFFER->no_sub are nonzero).  */
  395. extern int re_search (struct re_pattern_buffer *buffer,
  396.                       const char *string, int length,
  397.                       int start, int range, 
  398.               struct re_registers *regs);
  399.  
  400.  
  401. /* Like `re_search', but search in the concatenation of STRING1 and
  402.    STRING2.  Also, stop searching at index START + STOP.  */
  403. extern int re_search_2 (struct re_pattern_buffer *buffer,
  404.                         const char *string1, int length1,
  405.                 const char *string2, int length2,
  406.                         int start, int range, 
  407.                         struct re_registers *regs,
  408.                         int stop);
  409.  
  410.  
  411. /* Like `re_search', but return how many characters in STRING the regexp
  412.    in BUFFER matched, starting at position START.  */
  413. extern int re_match (struct re_pattern_buffer *buffer,
  414.                      const char *string, int length,
  415.                      int start, struct re_registers *regs);
  416.  
  417.  
  418. /* Relates to `re_match' as `re_search_2' relates to `re_search'.  */
  419. extern int re_match_2 (struct re_pattern_buffer *buffer,
  420.                        const char *string1, int length1,
  421.                    const char *string2, int length2,
  422.                        int start,
  423.                        struct re_registers *regs,
  424.                        int stop);
  425.  
  426.  
  427. /* Set REGS to hold NUM_REGS registers, storing them in STARTS and
  428.    ENDS.  Subsequent matches using BUFFER and REGS will use this memory
  429.    for recording register information.  STARTS and ENDS must be
  430.    allocated with malloc, and must each be at least `NUM_REGS * sizeof
  431.    (regoff_t)' bytes long.
  432.  
  433.    If NUM_REGS == 0, then subsequent matches should allocate their own
  434.    register data.
  435.  
  436.    Unless this function is called, the first search or match using
  437.    PATTERN_BUFFER will allocate its own register data, without
  438.    freeing the old data.  */
  439. extern void re_set_registers (struct re_pattern_buffer *buffer,
  440.                   struct re_registers *regs,
  441.                   unsigned num_regs,
  442.                   regoff_t *starts,
  443.                   regoff_t *ends);
  444.  
  445. /* 4.2 bsd compatibility.  */
  446. extern const char *re_comp (const char *);
  447. extern int re_exec (const char *);
  448.  
  449. /* POSIX compatibility.  */
  450. extern int regcomp (regex_t *preg, const char *pattern, int cflags);
  451. extern int regexec (const regex_t *preg, const char *string, size_t nmatch,
  452.             regmatch_t pmatch[], int eflags);
  453. extern size_t regerror (int errcode, const regex_t *preg, char *errbuf, 
  454.             size_t errbuf_size);
  455. extern void regfree (regex_t *preg);
  456.  
  457. #else /* not __STDC__ */
  458.  
  459. /* Support old C compilers.  */
  460. #define const
  461.  
  462. extern reg_syntax_t re_set_syntax ();
  463. extern char *re_compile_pattern ();
  464. extern int re_search (), re_search_2 ();
  465. extern int re_match (), re_match_2 ();
  466. extern void re_set_registers ();
  467.  
  468. /* 4.2 BSD compatibility.  */
  469. extern char *re_comp ();
  470. extern int re_exec ();
  471.  
  472. /* POSIX compatibility.  */
  473. extern int regcomp ();
  474. extern int regexec ();
  475. extern size_t regerror ();
  476. extern void regfree ();
  477.  
  478. #endif /* not __STDC__ */
  479. #endif /* not __REGEXP_LIBRARY_H__ */
  480.  
  481. /*
  482. Local variables:
  483. make-backup-files: t
  484. version-control: t
  485. trim-versions-without-asking: nil
  486. End:
  487. */
  488.